Package pl.wendigo.chrome.api.page

Contains DevTools Protocol Page domain implementation accessible via PageDomain class.

Types

AddCompilationCacheRequest

data class AddCompilationCacheRequest(url: String, data: String)

Represents request frame that can be used with Page#addCompilationCache operation call.

AddScriptToEvaluateOnLoadRequest

data class AddScriptToEvaluateOnLoadRequest(scriptSource: String)

Represents request frame that can be used with Page#addScriptToEvaluateOnLoad operation call.

AddScriptToEvaluateOnLoadResponse

data class AddScriptToEvaluateOnLoadResponse(identifier: ScriptIdentifier)

Represents response frame that is returned from Page#addScriptToEvaluateOnLoad operation call.

AddScriptToEvaluateOnNewDocumentRequest

data class AddScriptToEvaluateOnNewDocumentRequest(source: String, worldName: String?)

Represents request frame that can be used with Page#addScriptToEvaluateOnNewDocument operation call.

AddScriptToEvaluateOnNewDocumentResponse

data class AddScriptToEvaluateOnNewDocumentResponse(identifier: ScriptIdentifier)

Represents response frame that is returned from Page#addScriptToEvaluateOnNewDocument operation call.

AdFrameType

enum AdFrameType : Enum<AdFrameType>

Indicates whether a frame has been identified as an ad.

AppManifestError

data class AppManifestError(message: String, critical: Int, line: Int, column: Int)

Error while paring app manifest.

AppManifestParsedProperties

data class AppManifestParsedProperties(scope: String)

Parsed app manifest properties.

CaptureScreenshotRequest

data class CaptureScreenshotRequest(format: String?, quality: Int?, clip: Viewport?, fromSurface: Boolean?, captureBeyondViewport: Boolean?)

Represents request frame that can be used with Page#captureScreenshot operation call.

CaptureScreenshotResponse

data class CaptureScreenshotResponse(data: String)

Represents response frame that is returned from Page#captureScreenshot operation call.

CaptureSnapshotRequest

data class CaptureSnapshotRequest(format: String?)

Represents request frame that can be used with Page#captureSnapshot operation call.

CaptureSnapshotResponse

data class CaptureSnapshotResponse(data: String)

Represents response frame that is returned from Page#captureSnapshot operation call.

ClientNavigationDisposition

enum ClientNavigationDisposition : Enum<ClientNavigationDisposition>

ClientNavigationReason

enum ClientNavigationReason : Enum<ClientNavigationReason>

CompilationCacheParams

data class CompilationCacheParams(url: String, eager: Boolean?)

Per-script compilation cache parameters for Page.produceCompilationCache

CompilationCacheProducedEvent

data class CompilationCacheProducedEvent(url: String, data: String) : Event

Issued for every compilation cache generated.

CreateIsolatedWorldRequest

data class CreateIsolatedWorldRequest(frameId: FrameId, worldName: String?, grantUniveralAccess: Boolean?)

Represents request frame that can be used with Page#createIsolatedWorld operation call.

CreateIsolatedWorldResponse

data class CreateIsolatedWorldResponse(executionContextId: ExecutionContextId)

Represents response frame that is returned from Page#createIsolatedWorld operation call.

CrossOriginIsolatedContextType

enum CrossOriginIsolatedContextType : Enum<CrossOriginIsolatedContextType>

Indicates whether the frame is cross-origin isolated and why it is the case.

DeleteCookieRequest

data class DeleteCookieRequest(cookieName: String, url: String)

Represents request frame that can be used with Page#deleteCookie operation call.

DialogType

enum DialogType : Enum<DialogType>

Javascript dialog type.

DocumentOpenedEvent

data class DocumentOpenedEvent(frame: Frame) : Event

Fired when opening document to write to.

DomContentEventFiredEvent

data class DomContentEventFiredEvent(timestamp: MonotonicTime) : Event

DownloadProgressEvent

data class DownloadProgressEvent(guid: String, totalBytes: Double, receivedBytes: Double, state: String) : Event

Fired when download makes progress.

DownloadWillBeginEvent

data class DownloadWillBeginEvent(frameId: FrameId, guid: String, url: String, suggestedFilename: String) : Event

Fired when page is about to start a download.

FileChooserOpenedEvent

data class FileChooserOpenedEvent(frameId: FrameId, backendNodeId: BackendNodeId, mode: String) : Event

Emitted only when page.interceptFileChooser is enabled.

FontFamilies

data class FontFamilies(standard: String?, fixed: String?, serif: String?, sansSerif: String?, cursive: String?, fantasy: String?, pictograph: String?)

Generic font families collection.

FontSizes

data class FontSizes(standard: Int?, fixed: Int?)

Default font sizes.

Frame

data class Frame(id: FrameId, parentId: String?, loaderId: LoaderId, name: String?, url: String, urlFragment: String?, domainAndRegistry: String, securityOrigin: String, mimeType: String, unreachableUrl: String?, adFrameType: AdFrameType?, secureContextType: SecureContextType, crossOriginIsolatedContextType: CrossOriginIsolatedContextType, gatedAPIFeatures: List<GatedAPIFeatures>)

Information about the Frame on the page.

FrameAttachedEvent

data class FrameAttachedEvent(frameId: FrameId, parentFrameId: FrameId, stack: StackTrace?) : Event

Fired when frame has been attached to its parent.

FrameClearedScheduledNavigationEvent

data class FrameClearedScheduledNavigationEvent(frameId: FrameId) : Event

Fired when frame no longer has a scheduled navigation.

FrameDetachedEvent

data class FrameDetachedEvent(frameId: FrameId, reason: String) : Event

Fired when frame has been detached from its parent.

FrameId

typealias FrameId = String

Unique frame identifier.

FrameNavigatedEvent

data class FrameNavigatedEvent(frame: Frame) : Event

Fired once navigation of the frame has completed.

FrameRequestedNavigationEvent

data class FrameRequestedNavigationEvent(frameId: FrameId, reason: ClientNavigationReason, url: String, disposition: ClientNavigationDisposition) : Event

Fired when a renderer-initiated navigation is requested.

FrameResource

data class FrameResource(url: String, type: ResourceType, mimeType: String, lastModified: TimeSinceEpoch?, contentSize: Double?, failed: Boolean?, canceled: Boolean?)

Information about the Resource on the page.

FrameResourceTree

data class FrameResourceTree(frame: Frame, childFrames: List<FrameResourceTree>?, resources: List<FrameResource>)

Information about the Frame hierarchy along with their cached resources.

FrameScheduledNavigationEvent

data class FrameScheduledNavigationEvent(frameId: FrameId, delay: Double, reason: ClientNavigationReason, url: String) : Event

Fired when frame schedules a potential navigation.

FrameStartedLoadingEvent

data class FrameStartedLoadingEvent(frameId: FrameId) : Event

Fired when frame has started loading.

FrameStoppedLoadingEvent

data class FrameStoppedLoadingEvent(frameId: FrameId) : Event

Fired when frame has stopped loading.

FrameTree

data class FrameTree(frame: Frame, childFrames: List<FrameTree>?)

Information about the Frame hierarchy.

GatedAPIFeatures

enum GatedAPIFeatures : Enum<GatedAPIFeatures>

GenerateTestReportRequest

data class GenerateTestReportRequest(message: String, group: String?)

Represents request frame that can be used with Page#generateTestReport operation call.

GetAppManifestResponse

data class GetAppManifestResponse(url: String, errors: List<AppManifestError>, data: String?, parsed: AppManifestParsedProperties?)

Represents response frame that is returned from Page#getAppManifest operation call.

GetCookiesResponse

data class GetCookiesResponse(cookies: List<Cookie>)

Represents response frame that is returned from Page#getCookies operation call.

GetFrameTreeResponse

data class GetFrameTreeResponse(frameTree: FrameTree)

Represents response frame that is returned from Page#getFrameTree operation call.

GetInstallabilityErrorsResponse

data class GetInstallabilityErrorsResponse(installabilityErrors: List<InstallabilityError>)

Represents response frame that is returned from Page#getInstallabilityErrors operation call.

GetLayoutMetricsResponse

data class GetLayoutMetricsResponse(layoutViewport: LayoutViewport, visualViewport: VisualViewport, contentSize: Rect)

Represents response frame that is returned from Page#getLayoutMetrics operation call.

GetManifestIconsResponse

data class GetManifestIconsResponse(primaryIcon: String?)

Represents response frame that is returned from Page#getManifestIcons operation call.

GetNavigationHistoryResponse

data class GetNavigationHistoryResponse(currentIndex: Int, entries: List<NavigationEntry>)

Represents response frame that is returned from Page#getNavigationHistory operation call.

GetPermissionsPolicyStateRequest

data class GetPermissionsPolicyStateRequest(frameId: FrameId)

Represents request frame that can be used with Page#getPermissionsPolicyState operation call.

GetPermissionsPolicyStateResponse

data class GetPermissionsPolicyStateResponse(states: List<PermissionsPolicyFeatureState>)

Represents response frame that is returned from Page#getPermissionsPolicyState operation call.

GetResourceContentRequest

data class GetResourceContentRequest(frameId: FrameId, url: String)

Represents request frame that can be used with Page#getResourceContent operation call.

GetResourceContentResponse

data class GetResourceContentResponse(content: String, base64Encoded: Boolean)

Represents response frame that is returned from Page#getResourceContent operation call.

GetResourceTreeResponse

data class GetResourceTreeResponse(frameTree: FrameResourceTree)

Represents response frame that is returned from Page#getResourceTree operation call.

HandleJavaScriptDialogRequest

data class HandleJavaScriptDialogRequest(accept: Boolean, promptText: String?)

Represents request frame that can be used with Page#handleJavaScriptDialog operation call.

InstallabilityError

data class InstallabilityError(errorId: String, errorArguments: List<InstallabilityErrorArgument>)

The installability error

InstallabilityErrorArgument

data class InstallabilityErrorArgument(name: String, value: String)

JavascriptDialogClosedEvent

data class JavascriptDialogClosedEvent(result: Boolean, userInput: String) : Event

Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been closed.

JavascriptDialogOpeningEvent

data class JavascriptDialogOpeningEvent(url: String, message: String, type: DialogType, hasBrowserHandler: Boolean, defaultPrompt: String?) : Event

Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to open.

LayoutViewport

data class LayoutViewport(pageX: Int, pageY: Int, clientWidth: Int, clientHeight: Int)

Layout viewport position and dimensions.

LifecycleEventEvent

data class LifecycleEventEvent(frameId: FrameId, loaderId: LoaderId, name: String, timestamp: MonotonicTime) : Event

Fired for top level page lifecycle events such as navigation, load, paint, etc.

LoadEventFiredEvent

data class LoadEventFiredEvent(timestamp: MonotonicTime) : Event

NavigatedWithinDocumentEvent

data class NavigatedWithinDocumentEvent(frameId: FrameId, url: String) : Event

Fired when same-document navigation happens, e.g.

NavigateRequest

data class NavigateRequest(url: String, referrer: String?, transitionType: TransitionType?, frameId: FrameId?, referrerPolicy: ReferrerPolicy?)

Represents request frame that can be used with Page#navigate operation call.

NavigateResponse

data class NavigateResponse(frameId: FrameId, loaderId: LoaderId?, errorText: String?)

Represents response frame that is returned from Page#navigate operation call.

NavigateToHistoryEntryRequest

data class NavigateToHistoryEntryRequest(entryId: Int)

Represents request frame that can be used with Page#navigateToHistoryEntry operation call.

NavigationEntry

data class NavigationEntry(id: Int, url: String, userTypedURL: String, title: String, transitionType: TransitionType)

Navigation history entry.

PageDomain

class PageDomain : Domain

Actions and events related to the inspected page belong to the page domain.

PermissionsPolicyBlockLocator

data class PermissionsPolicyBlockLocator(frameId: FrameId, blockReason: PermissionsPolicyBlockReason)

PermissionsPolicyBlockReason

enum PermissionsPolicyBlockReason : Enum<PermissionsPolicyBlockReason>

Reason for a permissions policy feature to be disabled.

PermissionsPolicyFeature

enum PermissionsPolicyFeature : Enum<PermissionsPolicyFeature>

All Permissions Policy features.

PermissionsPolicyFeatureState

data class PermissionsPolicyFeatureState(feature: PermissionsPolicyFeature, allowed: Boolean, locator: PermissionsPolicyBlockLocator?)

PrintToPDFRequest

data class PrintToPDFRequest(landscape: Boolean?, displayHeaderFooter: Boolean?, printBackground: Boolean?, scale: Double?, paperWidth: Double?, paperHeight: Double?, marginTop: Double?, marginBottom: Double?, marginLeft: Double?, marginRight: Double?, pageRanges: String?, ignoreInvalidPageRanges: Boolean?, headerTemplate: String?, footerTemplate: String?, preferCSSPageSize: Boolean?, transferMode: String?)

Represents request frame that can be used with Page#printToPDF operation call.

PrintToPDFResponse

data class PrintToPDFResponse(data: String, stream: StreamHandle?)

Represents response frame that is returned from Page#printToPDF operation call.

ProduceCompilationCacheRequest

data class ProduceCompilationCacheRequest(scripts: List<CompilationCacheParams>)

Represents request frame that can be used with Page#produceCompilationCache operation call.

ReferrerPolicy

enum ReferrerPolicy : Enum<ReferrerPolicy>

The referring-policy used for the navigation.

ReloadRequest

data class ReloadRequest(ignoreCache: Boolean?, scriptToEvaluateOnLoad: String?)

Represents request frame that can be used with Page#reload operation call.

RemoveScriptToEvaluateOnLoadRequest

data class RemoveScriptToEvaluateOnLoadRequest(identifier: ScriptIdentifier)

Represents request frame that can be used with Page#removeScriptToEvaluateOnLoad operation call.

RemoveScriptToEvaluateOnNewDocumentRequest

data class RemoveScriptToEvaluateOnNewDocumentRequest(identifier: ScriptIdentifier)

Represents request frame that can be used with Page#removeScriptToEvaluateOnNewDocument operation call.

ScreencastFrameAckRequest

data class ScreencastFrameAckRequest(sessionId: Int)

Represents request frame that can be used with Page#screencastFrameAck operation call.

ScreencastFrameEvent

data class ScreencastFrameEvent(data: String, metadata: ScreencastFrameMetadata, sessionId: Int) : Event

Compressed image data requested by the startScreencast.

ScreencastFrameMetadata

data class ScreencastFrameMetadata(offsetTop: Double, pageScaleFactor: Double, deviceWidth: Double, deviceHeight: Double, scrollOffsetX: Double, scrollOffsetY: Double, timestamp: TimeSinceEpoch?)

Screencast frame metadata.

ScreencastVisibilityChangedEvent

data class ScreencastVisibilityChangedEvent(visible: Boolean) : Event

Fired when the page with currently enabled screencast was shown or hidden `.

ScriptIdentifier

typealias ScriptIdentifier = String

Unique script identifier.

SearchInResourceRequest

data class SearchInResourceRequest(frameId: FrameId, url: String, query: String, caseSensitive: Boolean?, isRegex: Boolean?)

Represents request frame that can be used with Page#searchInResource operation call.

SearchInResourceResponse

data class SearchInResourceResponse(result: List<SearchMatch>)

Represents response frame that is returned from Page#searchInResource operation call.

SecureContextType

enum SecureContextType : Enum<SecureContextType>

Indicates whether the frame is a secure context and why it is the case.

SetAdBlockingEnabledRequest

data class SetAdBlockingEnabledRequest(enabled: Boolean)

Represents request frame that can be used with Page#setAdBlockingEnabled operation call.

SetBypassCSPRequest

data class SetBypassCSPRequest(enabled: Boolean)

Represents request frame that can be used with Page#setBypassCSP operation call.

SetDeviceMetricsOverrideRequest

data class SetDeviceMetricsOverrideRequest(width: Int, height: Int, deviceScaleFactor: Double, mobile: Boolean, scale: Double?, screenWidth: Int?, screenHeight: Int?, positionX: Int?, positionY: Int?, dontSetVisibleSize: Boolean?, screenOrientation: ScreenOrientation?, viewport: Viewport?)

Represents request frame that can be used with Page#setDeviceMetricsOverride operation call.

SetDeviceOrientationOverrideRequest

data class SetDeviceOrientationOverrideRequest(alpha: Double, beta: Double, gamma: Double)

Represents request frame that can be used with Page#setDeviceOrientationOverride operation call.

SetDocumentContentRequest

data class SetDocumentContentRequest(frameId: FrameId, html: String)

Represents request frame that can be used with Page#setDocumentContent operation call.

SetDownloadBehaviorRequest

data class SetDownloadBehaviorRequest(behavior: String, downloadPath: String?)

Represents request frame that can be used with Page#setDownloadBehavior operation call.

SetFontFamiliesRequest

data class SetFontFamiliesRequest(fontFamilies: FontFamilies)

Represents request frame that can be used with Page#setFontFamilies operation call.

SetFontSizesRequest

data class SetFontSizesRequest(fontSizes: FontSizes)

Represents request frame that can be used with Page#setFontSizes operation call.

SetGeolocationOverrideRequest

data class SetGeolocationOverrideRequest(latitude: Double?, longitude: Double?, accuracy: Double?)

Represents request frame that can be used with Page#setGeolocationOverride operation call.

SetInterceptFileChooserDialogRequest

data class SetInterceptFileChooserDialogRequest(enabled: Boolean)

Represents request frame that can be used with Page#setInterceptFileChooserDialog operation call.

SetLifecycleEventsEnabledRequest

data class SetLifecycleEventsEnabledRequest(enabled: Boolean)

Represents request frame that can be used with Page#setLifecycleEventsEnabled operation call.

SetProduceCompilationCacheRequest

data class SetProduceCompilationCacheRequest(enabled: Boolean)

Represents request frame that can be used with Page#setProduceCompilationCache operation call.

SetTouchEmulationEnabledRequest

data class SetTouchEmulationEnabledRequest(enabled: Boolean, configuration: String?)

Represents request frame that can be used with Page#setTouchEmulationEnabled operation call.

SetWebLifecycleStateRequest

data class SetWebLifecycleStateRequest(state: String)

Represents request frame that can be used with Page#setWebLifecycleState operation call.

StartScreencastRequest

data class StartScreencastRequest(format: String?, quality: Int?, maxWidth: Int?, maxHeight: Int?, everyNthFrame: Int?)

Represents request frame that can be used with Page#startScreencast operation call.

TransitionType

enum TransitionType : Enum<TransitionType>

Transition type.

Viewport

data class Viewport(x: Double, y: Double, width: Double, height: Double, scale: Double)

Viewport for capturing screenshot.

VisualViewport

data class VisualViewport(offsetX: Double, offsetY: Double, pageX: Double, pageY: Double, clientWidth: Double, clientHeight: Double, scale: Double, zoom: Double?)

Visual viewport position, dimensions, and scale.

WindowOpenEvent

data class WindowOpenEvent(url: String, windowName: String, windowFeatures: List<String>, userGesture: Boolean) : Event

Fired when a new window is going to be opened, via window.open(), link click, form submission, etc.